Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: rewrite command descriptions #727

Merged
merged 16 commits into from
Jan 15, 2025
Merged

Conversation

TC-MO
Copy link
Contributor

@TC-MO TC-MO commented Jan 15, 2025

Rewrites command descriptions.
Changes Dataset to dataset when appropriate within descriptions.
Changes Key-value store to key-value store when appropriate within descriptions.

@TC-MO TC-MO requested a review from netmilk January 15, 2025 09:15
@TC-MO TC-MO self-assigned this Jan 15, 2025
@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Jan 15, 2025
@TC-MO TC-MO marked this pull request as ready for review January 15, 2025 10:48
src/commands/logout.ts Outdated Show resolved Hide resolved
src/commands/logout.ts Outdated Show resolved Hide resolved
fix typos

Co-authored-by: Adam Kliment <[email protected]>
src/commands/secrets/add.ts Outdated Show resolved Hide resolved
src/commands/actor/index.ts Outdated Show resolved Hide resolved
src/commands/actor/set-value.ts Outdated Show resolved Hide resolved
src/commands/init.ts Outdated Show resolved Hide resolved
src/commands/run.ts Outdated Show resolved Hide resolved
src/commands/task/run.ts Outdated Show resolved Hide resolved
TC-MO and others added 3 commits January 15, 2025 12:53
add missing quotes in descriptions
change double quotes to single quotes throughout descriptions for
consistency
fixed KeyValueStore to key-value store
Consisteny regarding login requirement
@TC-MO TC-MO requested review from vladfrangu and netmilk January 15, 2025 11:58
src/commands/actors/call.ts Outdated Show resolved Hide resolved
src/commands/actors/pull.ts Outdated Show resolved Hide resolved
src/commands/actors/push.ts Outdated Show resolved Hide resolved
src/commands/actors/start.ts Outdated Show resolved Hide resolved
src/commands/datasets/create.ts Outdated Show resolved Hide resolved
Removed mentions of creating named dataset & alligned it with kvs create
description for consistency
change the way description of push is written
Rewrite pull command description to remove mentions of Web IDE files
@TC-MO TC-MO requested a review from B4nan January 15, 2025 13:12
src/commands/actor/index.ts Outdated Show resolved Hide resolved
src/commands/secrets/add.ts Outdated Show resolved Hide resolved
Fix typo (missing periods)
Remove trailing \n at the end of description
Add missing periods
Fix inconsistency in run commands
Copy link
Member

@B4nan B4nan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apart from the requires login thing its all good from my end

@vladfrangu
Copy link
Member

I'll merge this as is, please open new PRs if you spot anything else remaining!

@vladfrangu vladfrangu enabled auto-merge (squash) January 15, 2025 18:35
@vladfrangu vladfrangu merged commit 3eb21d6 into master Jan 15, 2025
17 checks passed
@vladfrangu vladfrangu deleted the command-description-rewrite branch January 15, 2025 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants